Node / meshtastic / Meshtastic-Android / files / .github / agents / speckit.brownfield.scan.agent.md

Displaying Rendered • View raw • Download

description: Auto-discover project structure, tech stack, frameworks, and architecture

patterns

<!-- Extension: brownfield -->

<!-- Config: .specify/extensions/brownfield/ -->

Analyze an existing codebase to discover its technology stack, architecture patterns, module structure, and coding conventions. This produces a project profile that the bootstrap command uses to generate tailored spec-kit configuration.

T282828

You MUST consider the user input before proceeding (if not empty). The user may specify a subdirectory to scan (e.g., "backend/"), a focus area (e.g., "only frontend"), or request a specific depth of analysis.

1. Verify the current directory is a git repository

2. Verify this is an existing project with source code (not an empty repo)

1. Detect tech stack: Identify languages, frameworks, and tools by scanning:

2. Analyze architecture: Identify the project's structural patterns:

3. Map module structure: For monorepos and multi-module projects:

• Identify each module/package/service and its purpose

• Detect inter-module dependencies (imports, shared types)

• Note module boundaries (what code belongs where)

• Identify shared libraries or utilities

4. Extract conventions: Detect existing coding patterns:

• Naming: File naming (camelCase, kebab-case, snake_case), directory naming

• Branching: Existing branch names and patterns from T383838git branch -a

• Commit style: Recent commit message patterns from T383838git log --oneline -20

• Testing: Test file location (T383838__tests__/, T383838*_test.go, T383838test_*.py), test naming

• Documentation: README structure, inline docs, API docs

5. Detect existing governance: Check for files that indicate existing project standards:

• T383838CONTRIBUTING.md, T383838ARCHITECTURE.md, T383838ADR/ (Architecture Decision Records)

• T383838.editorconfig, linter configs (T383838.eslintrc, T383838.flake8, T383838rustfmt.toml)

• T383838CLAUDE.md, T383838AGENTS.md, T383838.specify/ (existing spec-kit setup)

6. Output project profile:

T282828

Tff7b72- **Pattern**: Frontend + Backend (separated)

Tff7b72- **Frontend**: Ta5d6ff`client/` — React SPA

Tff7b72- **Backend**: Ta5d6ff`server/` — FastAPI REST API

Tff7b72- **Database**: PostgreSQL (via SQLAlchemy ORM)

## Module Map

| Module | Path | Purpose | Dependencies |

|--------|------|---------|-------------|

| Frontend | Ta5d6ff`client/` | React SPA | Backend API |

| Backend | Ta5d6ff`server/` | REST API | Database |

| Shared | Ta5d6ff`shared/` | Type definitions | — |

## Conventions

Tff7b72- **File naming**: kebab-case (frontend), snake_case (backend)

Tff7b72- **Branch pattern**: Ta5d6ff`feat/*`, Ta5d6ff`fix/*`, Ta5d6ff`chore/*`

Tff7b72- **Commit style**: Conventional Commits

Tff7b72- **Test location**: Ta5d6ff`__tests__/` (frontend), Ta5d6ff`tests/` (backend)

## Existing Governance

Tff7b72- ✅ CONTRIBUTING.md

Tff7b72- ✅ .eslintrc.json

Tff7b72- ❌ ARCHITECTURE.md

Tff7b72- ❌ .specify/ (no spec-kit setup)

## Recommendations

Tff7b72- Run Ta5d6ff`/speckit.brownfield.bootstrap` to generate tailored spec-kit configuration

Tff7b72- Constitution should enforce: kebab-case files (frontend), snake_case (backend)

Tff7b72- Feature specs should map to the frontend/backend split

• Read-only — this command never modifies any files

• Respect .gitignore — never scan T383838node_modules/, T383838vendor/, T383838dist/, T383838.venv/, or other ignored directories

• Proportional analysis — report language percentages based on actual file counts or line counts

• No assumptions — only report what is actually detected in the codebase

• Handle empty results — if a category has nothing detected, say "Not detected" rather than guessing